<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>Catharsis.NET.Commons: Catharsis.Commons.StreamExtensions Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Catharsis.NET.Commons
   &#160;<span id="projectnumber">2.8</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_catharsis_1_1_commons_1_1_stream_extensions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Properties</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_catharsis_1_1_commons_1_1_stream_extensions-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Catharsis.Commons.StreamExtensions Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p> 
 <a href="class_catharsis_1_1_commons_1_1_stream_extensions.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a1ab77744bc8612a67c9885cb3962f3c1"><td class="memItemLeft" align="right" valign="top">static XDocument&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a1ab77744bc8612a67c9885cb3962f3c1">AsXDocument</a> (this Stream self, bool close=false)</td></tr>
<tr class="separator:a1ab77744bc8612a67c9885cb3962f3c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c31ee3f5c45117df26706f299cd90cb"><td class="memItemLeft" align="right" valign="top">static BinaryReader&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a8c31ee3f5c45117df26706f299cd90cb">BinaryReader</a> (this Stream self, Encoding encoding=null)</td></tr>
<tr class="separator:a8c31ee3f5c45117df26706f299cd90cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1add8549471e18f45ccc3d2a607ebe48"><td class="memItemLeft" align="right" valign="top">static BinaryWriter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a1add8549471e18f45ccc3d2a607ebe48">BinaryWriter</a> (this Stream self, Encoding encoding=null)</td></tr>
<tr class="separator:a1add8549471e18f45ccc3d2a607ebe48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a096be75891c22e67ee3dad3ecc250255"><td class="memItemLeft" align="right" valign="top">static byte[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a096be75891c22e67ee3dad3ecc250255">Bytes</a> (this Stream self, bool close=false)</td></tr>
<tr class="separator:a096be75891c22e67ee3dad3ecc250255"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a635af6ed4214e9127a9abaa6472285c5"><td class="memItemLeft" align="right" valign="top">static T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a635af6ed4214e9127a9abaa6472285c5">Rewind&lt; T &gt;</a> (this T self)</td></tr>
<tr class="separator:a635af6ed4214e9127a9abaa6472285c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac142059d77a936f8fca89100992f467a"><td class="memItemLeft" align="right" valign="top">static string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#ac142059d77a936f8fca89100992f467a">Text</a> (this Stream self, bool close=false, Encoding encoding=null)</td></tr>
<tr class="separator:ac142059d77a936f8fca89100992f467a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a5b7d9f73f76143581bce3766ff6e45"><td class="memItemLeft" align="right" valign="top">static TextReader&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a0a5b7d9f73f76143581bce3766ff6e45">TextReader</a> (this Stream self, Encoding encoding=null)</td></tr>
<tr class="separator:a0a5b7d9f73f76143581bce3766ff6e45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9caacb7c5b1cc4949e7326c5a1b454da"><td class="memItemLeft" align="right" valign="top">static TextWriter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a9caacb7c5b1cc4949e7326c5a1b454da">TextWriter</a> (this Stream self, Encoding encoding=null)</td></tr>
<tr class="separator:a9caacb7c5b1cc4949e7326c5a1b454da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cd21ddbeca3d19b111d7ee4e43756cc"><td class="memItemLeft" align="right" valign="top">static T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a7cd21ddbeca3d19b111d7ee4e43756cc">Write&lt; T &gt;</a> (this T self, byte[] bytes)</td></tr>
<tr class="separator:a7cd21ddbeca3d19b111d7ee4e43756cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7e0f095ac04f73629ca781276fd72e6"><td class="memItemLeft" align="right" valign="top">static T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#aa7e0f095ac04f73629ca781276fd72e6">Write&lt; T &gt;</a> (this T self, Stream from)</td></tr>
<tr class="separator:aa7e0f095ac04f73629ca781276fd72e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac44925e6a467a9a3cd215e1dc2bc061f"><td class="memItemLeft" align="right" valign="top">static T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#ac44925e6a467a9a3cd215e1dc2bc061f">Write&lt; T &gt;</a> (this T self, string text, Encoding encoding=null)</td></tr>
<tr class="separator:ac44925e6a467a9a3cd215e1dc2bc061f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61d9f590ae1d013a403b56b8792a9024"><td class="memItemLeft" align="right" valign="top">static XmlReader&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a61d9f590ae1d013a403b56b8792a9024">XmlReader</a> (this Stream self, bool close=false)</td></tr>
<tr class="separator:a61d9f590ae1d013a403b56b8792a9024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60b77039f00170de4bc542d880d4dd4d"><td class="memItemLeft" align="right" valign="top">static XmlWriter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a60b77039f00170de4bc542d880d4dd4d">XmlWriter</a> (this Stream self, bool close=false, Encoding encoding=null)</td></tr>
<tr class="separator:a60b77039f00170de4bc542d880d4dd4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Set of extension methods for class Stream.</p>
<dl class="section see"><dt>See also</dt><dd>Stream</dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1ab77744bc8612a67c9885cb3962f3c1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static XDocument Catharsis.Commons.StreamExtensions.AsXDocument </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>close</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Deserializes XML data from source Stream as XDocument object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Source stream with XML data.</td></tr>
    <tr><td class="paramname">close</td><td>Whether to automatically close source stream after successfull deserialization.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XDocument document, constructed from data in <em>self</em>  stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>XDocument</dd></dl>

</div>
</div>
<a class="anchor" id="a8c31ee3f5c45117df26706f299cd90cb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static BinaryReader Catharsis.Commons.StreamExtensions.BinaryReader </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Encoding&#160;</td>
          <td class="paramname"><em>encoding</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a8c31ee3f5c45117df26706f299cd90cb">BinaryReader</a> for reading data from specified Stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Source stream to read from.</td></tr>
    <tr><td class="paramname">encoding</td><td>Text encoding to use by <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a8c31ee3f5c45117df26706f299cd90cb">BinaryReader</a>. If not specified, default Encoding.UTF8 will be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Binary reader instance that wraps self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a8c31ee3f5c45117df26706f299cd90cb">BinaryReader</a>, BinaryWriter(Stream, Encoding)</dd></dl>

</div>
</div>
<a class="anchor" id="a1add8549471e18f45ccc3d2a607ebe48"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static BinaryWriter Catharsis.Commons.StreamExtensions.BinaryWriter </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Encoding&#160;</td>
          <td class="paramname"><em>encoding</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a1add8549471e18f45ccc3d2a607ebe48">BinaryWriter</a> for writing data to specified Stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Target stream to write to.</td></tr>
    <tr><td class="paramname">encoding</td><td>Text encoding to use by <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a1add8549471e18f45ccc3d2a607ebe48">BinaryWriter</a>. If not specified, default Encoding.UTF8 will be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Binary writer instance that wraps self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a1add8549471e18f45ccc3d2a607ebe48">BinaryWriter</a>, BinaryReader(Stream, Encoding)</dd></dl>

</div>
</div>
<a class="anchor" id="a096be75891c22e67ee3dad3ecc250255"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static byte [] Catharsis.Commons.StreamExtensions.Bytes </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>close</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Read the content of this Stream and return it as a byte array. The input is closed before this method returns.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td></td></tr>
    <tr><td class="paramname">close</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The byte array from that <em>self</em> </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a635af6ed4214e9127a9abaa6472285c5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static T Catharsis.Commons.StreamExtensions.Rewind&lt; T &gt; </td>
          <td>(</td>
          <td class="paramtype">this T&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Sets the position within source Stream to the beginning of a stream, if this stream supports seeking operations.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>Type of source stream.</td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Source stream.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Back reference to <em>self</em>  stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>Stream.Seek(long, SeekOrigin)</dd></dl>
<div class="typeconstraint">
<dl><dt><b>Type Constraints</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>T</em></td><td>&#160;:</td><td valign="top"><em>Stream</em></td><td>&#160;</td></tr>
</table>
</dl>
</div>

</div>
</div>
<a class="anchor" id="ac142059d77a936f8fca89100992f467a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static string Catharsis.Commons.StreamExtensions.Text </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>close</em> = <code>false</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Encoding&#160;</td>
          <td class="paramname"><em>encoding</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns all available text data from a source stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Source stream to read from.</td></tr>
    <tr><td class="paramname">close</td><td>Whether to automatically close source stream when all available data has been successfully read from it.</td></tr>
    <tr><td class="paramname">encoding</td><td>Encoding to be used for bytes-to-text conversion. If not specified, default Encoding.UTF8 will be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Text data from a self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a0a5b7d9f73f76143581bce3766ff6e45"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static TextReader Catharsis.Commons.StreamExtensions.TextReader </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Encoding&#160;</td>
          <td class="paramname"><em>encoding</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a0a5b7d9f73f76143581bce3766ff6e45">TextReader</a> for reading text data from specified Stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Source stream to read from.</td></tr>
    <tr><td class="paramname">encoding</td><td>Text encoding to use by <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a0a5b7d9f73f76143581bce3766ff6e45">TextReader</a>. If not specified, default Encoding.UTF8 will be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Text reader instance that wraps self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a0a5b7d9f73f76143581bce3766ff6e45">TextReader</a>, TextWriter(Stream, Encoding)</dd></dl>

</div>
</div>
<a class="anchor" id="a9caacb7c5b1cc4949e7326c5a1b454da"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static TextWriter Catharsis.Commons.StreamExtensions.TextWriter </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Encoding&#160;</td>
          <td class="paramname"><em>encoding</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a9caacb7c5b1cc4949e7326c5a1b454da">TextWriter</a> for writing text data to specified Stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Target stream to write to.</td></tr>
    <tr><td class="paramname">encoding</td><td>Text encoding to use by <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a9caacb7c5b1cc4949e7326c5a1b454da">TextWriter</a>. If not specified, default Encoding.UTF8 will be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Text writer instance that wraps self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a9caacb7c5b1cc4949e7326c5a1b454da">TextWriter</a>, TextReader(Stream, Encoding)</dd></dl>

</div>
</div>
<a class="anchor" id="a7cd21ddbeca3d19b111d7ee4e43756cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static T Catharsis.Commons.StreamExtensions.Write&lt; T &gt; </td>
          <td>(</td>
          <td class="paramtype">this T&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">byte[]&#160;</td>
          <td class="paramname"><em>bytes</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Writes binary data to target stream.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>Type of target stream.</td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Target stream to write to.</td></tr>
    <tr><td class="paramname">bytes</td><td>Binary data to write to a stream.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Back reference to self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If either <em>self</em>  or <em>bytes</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>Write{T}(T, Stream), Write{T}(T, string, Encoding)</dd></dl>
<div class="typeconstraint">
<dl><dt><b>Type Constraints</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>T</em></td><td>&#160;:</td><td valign="top"><em>Stream</em></td><td>&#160;</td></tr>
</table>
</dl>
</div>

</div>
</div>
<a class="anchor" id="aa7e0f095ac04f73629ca781276fd72e6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static T Catharsis.Commons.StreamExtensions.Write&lt; T &gt; </td>
          <td>(</td>
          <td class="paramtype">this T&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Stream&#160;</td>
          <td class="paramname"><em>from</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>"Pipes" two streams by writing all available data from one to another.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>Type of target stream.</td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Target stream to write data to.</td></tr>
    <tr><td class="paramname">from</td><td>Source stream to read data from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Back reference to target stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If either <em>self</em>  or <em>from</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>Write{T}(T, byte[]), Write{T}(T, string, Encoding)</dd></dl>
<div class="typeconstraint">
<dl><dt><b>Type Constraints</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>T</em></td><td>&#160;:</td><td valign="top"><em>Stream</em></td><td>&#160;</td></tr>
</table>
</dl>
</div>

</div>
</div>
<a class="anchor" id="ac44925e6a467a9a3cd215e1dc2bc061f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static T Catharsis.Commons.StreamExtensions.Write&lt; T &gt; </td>
          <td>(</td>
          <td class="paramtype">this T&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>text</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Encoding&#160;</td>
          <td class="paramname"><em>encoding</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Writes text data to target Stream, using specified Encoding.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>Type of target stream.</td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Target stream to write to.</td></tr>
    <tr><td class="paramname">text</td><td>Text to write to a stream.</td></tr>
    <tr><td class="paramname">encoding</td><td>Encoding to be used for text-to-bytes conversion. If not specified, default Encoding.UTF8 will be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Back reference to self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If either <em>self</em>  or <em>text</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>Write{T}(T, byte[]), Write{T}(T, Stream)</dd></dl>
<div class="typeconstraint">
<dl><dt><b>Type Constraints</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>T</em></td><td>&#160;:</td><td valign="top"><em>Stream</em></td><td>&#160;</td></tr>
</table>
</dl>
</div>

</div>
</div>
<a class="anchor" id="a61d9f590ae1d013a403b56b8792a9024"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static XmlReader Catharsis.Commons.StreamExtensions.XmlReader </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>close</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a61d9f590ae1d013a403b56b8792a9024">XmlReader</a> for reading XML data from specified Stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Source stream to read from.</td></tr>
    <tr><td class="paramname">close</td><td>Whether resulting System.Xml.XmlReader should close underlying stream when its System.Xml.XmlReader.Close() method will be called.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XML reader instance that wraps self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a61d9f590ae1d013a403b56b8792a9024">XmlReader</a>, XmlWriter(Stream, bool, Encoding)</dd></dl>

</div>
</div>
<a class="anchor" id="a60b77039f00170de4bc542d880d4dd4d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static XmlWriter Catharsis.Commons.StreamExtensions.XmlWriter </td>
          <td>(</td>
          <td class="paramtype">this Stream&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>close</em> = <code>false</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Encoding&#160;</td>
          <td class="paramname"><em>encoding</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a60b77039f00170de4bc542d880d4dd4d">XmlWriter</a> for writing XML data to specified Stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>Target stream to write to.</td></tr>
    <tr><td class="paramname">close</td><td>Whether resulting System.Xml.XmlWriter should close underlying stream when its System.Xml.XmlWriter.Close() method will be called.</td></tr>
    <tr><td class="paramname">encoding</td><td>Text encoding to use by <a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a60b77039f00170de4bc542d880d4dd4d">XmlWriter</a>. If not specified, default Encoding.UTF8 will be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XML writer instance that wraps self stream.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>self</em>  is a <code>null</code> reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html#a60b77039f00170de4bc542d880d4dd4d">XmlWriter</a>, XmlReader(Stream, bool)</dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_catharsis.html">Catharsis</a></li><li class="navelem"><a class="el" href="namespace_catharsis_1_1_commons.html">Commons</a></li><li class="navelem"><a class="el" href="class_catharsis_1_1_commons_1_1_stream_extensions.html">StreamExtensions</a></li>
    <li class="footer">Generated on Wed Aug 6 2014 00:10:37 for Catharsis.NET.Commons by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
  </ul>
</div>
</body>
</html>
